home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / lawn.zip / XR.DOC < prev   
Text File  |  1991-07-08  |  5KB  |  125 lines
  1.  
  2.                      XR v1.14 - X10 Report Program
  3.                  Copyright (c) 1991 by Adrienne Cousins
  4.                           All Rights Reserved
  5.  
  6.                               VersaWare
  7.                 30 Jennifer Street, Littleton, MA 01460
  8.                   508-486-9351 (Voice 9am-4pm Eastern)
  9.                    508-486-8507 (24 hour Support BBS)
  10.  
  11.  
  12.  This program provides a couple of simple functions for the X10 that I have
  13.  been unable to find in any other X10 program, and have found very useful
  14.  while connecting and reprogramming my X10 computer interface.
  15.  
  16.  The most useful function is the STATUS report (-S) which requests the
  17.  X10 to return an actual list of currently programmed events.
  18.  XR will translate the data returned from the X10 into an english format
  19.  report using the same "tokens" as the XA program.  This report will
  20.  show ALL events that are programmed in the X10 (many X10 control programs
  21.  do not clear prior events before programming new ones), and will also
  22.  show actual times that were calculated by "tokens" such as SUNRISE and
  23.  SUNSET.
  24.  
  25.  The other useful function is the WATCH function (-W) which monitors the
  26.  serial port for data received from the X10.  Anytime a rocker switch is
  27.  pressed, or a programmed event occurs, the X10 sends a data packet to
  28.  the PC describing the event that just occurred.  If XR is running in
  29.  WATCH mode when this happens, the event is described on screen using the
  30.  same english "tokens" used by the XA program.
  31.  
  32.  All output from XR can be redirected to any standard output device or
  33.  disk file.
  34.  
  35.                   -----------------------------------------
  36.  
  37.  XR command syntax & functions:
  38.  
  39.         XR [<cmd>][,<cmd>][,<cmd>] [>>outfile]
  40.  
  41.  Where <cmd> can be any of the following switches.
  42.  
  43.  ?      Print a short help text to the screen
  44.  
  45.  -A     Echo all X10 I/O to the screen in ascii
  46.         Causes all data sent to or received from the X10 to be echoed to
  47.         the screen in ascii.  This can also be redirected to any standard
  48.         output device or file.
  49.  
  50.  -Bn    Set baud rate of serial port (300-19200)
  51.         Causes the serial port to be set to the specified speed.
  52.         If this switch is not specified, XR will use the serial port at
  53.         the currently initialized speed.
  54.         This is so that XR can also be used with X10s attached via Lawns.
  55.  
  56.                 XR -B600,-W
  57.  
  58.  -H     Echo all X10 I/O to the screen in hexadecimal
  59.         Causes all data sent to or received from the X10 to be echoed to
  60.         the screen as hexadecimal bytes.  This data can also be redirected
  61.         to any standard output device or file.
  62.  
  63.                 XR -H,-W
  64.  
  65.  -Pn    Serial port that X10 is connected to (1-4)
  66.         Use this switch to specify a serial port other the default of COM1.
  67.         Multiple -P switches may appear on the line, to send commands to
  68.         multiple serial ports in a single command.
  69.  
  70.                 XR -P1,-S,-P2,-S
  71.  
  72.  -S     Display status of all events in the X10
  73.         Causes the X10 to be queried for a list of all events currently
  74.         programmed.  The data will be translated into english "tokens"
  75.         and displayed on the screen.  This report can also be redirected
  76.         to any standard output device or file.
  77.  
  78.                 XR -S >X10STS.LOG
  79.  
  80.  -Tf:l  Change X10 timeout tick counts (first:last)
  81.         The value called FIRST, is the timeout in ticks until the first
  82.         byte is received from the X10.  The value called LAST, is the
  83.         timeout in ticks after the last byte is received from the X10.
  84.         FIRST defaults to 36 (2 secs), and LAST defaults to 18 (1 sec).
  85.  
  86.  -W     Watch for any data received from the X10
  87.         This monitors the serial port for any data received from the X10.
  88.         It may be used in conjunction with the -A and -H echo switches.
  89.         This mode is terminated on any keystroke.
  90.  
  91.                 XR -H,-W
  92.  
  93.         -----------------------------------------------------------
  94.  
  95.  A list of the tokens used by XR are as follows:
  96.  
  97.         HOUSE, NORMAL, SECURITY
  98.         TODAY, TOMORROW, EVERYDAY, WEEKENDS, WEEKDAYS
  99.         MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
  100.         TIME, UNIT, LEVEL, ON, OFF, DIM, An-Pn
  101.  
  102.  A sample status report follows:
  103.  
  104.         XR -S
  105.         Status:1 TIME 6:52 pm MONDAY HOUSE A
  106.         Event:0 NORMAL WEEKENDS TIME 4:00 am A8 Level:0 ON
  107.         Event:1 NORMAL WEEKDAYS TIME 7:00 am A8 Level:0 ON
  108.         Event:2 NORMAL EVERYDAY TIME 8:53 pm A2 Level:7 DIM
  109.         Event:3 NORMAL EVERYDAY TIME 9:00 pm A2 Level:3 DIM
  110.         Event:4 NORMAL EVERYDAY TIME 12:00 am A2 Level:0 OFF
  111.         Event:5 NORMAL EVERYDAY TIME 8:53 pm A3 Level:7 DIM
  112.         Event:6 NORMAL EVERYDAY TIME 10:00 pm A3 Level:11 DIM
  113.         Event:7 NORMAL EVERYDAY TIME 4:49 am A3 Level:0 OFF
  114.  
  115.  A sample WATCH session with HEX echo enabled follows:
  116.  
  117.         XR -H,-W
  118.         Press any key to exit Watch mode
  119.         <R:FF FF FF FF FF FF 01 62 00 08 60 CA
  120.         Status:1 ON A5
  121.         <R:FF FF FF FF FF FF 01 63 00 08 60 CB
  122.         Status:1 OFF A5
  123.  
  124.  
  125.